
<html>

<head>
  <title>Ruby English</title>

  <meta name="description" content="Ruby programming library for text manipulation and english language processing."/>
  <meta name="keywords" content="ruby, grammer, programming, text, string, english"/>

  <link href="assets/style.css" rel="stylesheet" type="text/css"/>
  <link href="assets/images/letter-e.jpg" rel="icon"/>


  <script type="text/javascript">
  </script>
</head>

<body>

<div id="container">

  <div style="width: 800px; margin: 0 auto; height: 72px; text-align: center;">
    <a href="http://rubyworks.github.com" style="font-family: courier; font-size: 42px; color: white; text-decoration: none;">
      <!-- <img src="http://tigerops.org/assets/images/tiger-sm.png" align="left"/> -->
      <!-- <img src="http://rubyworks.github.com/assets/images/rubyworks.png" align="top" width="200px" /> -->
      The Ruby Gengo Project
    </a>
  </div>

  <div id="menu">
    <!-- <a href="http://groups.google.com/group/rubyworks-mailinglist/">EMail</a> -->
    <a href="docs/api/index.html">API</a>
    <!-- <a href="qedoc/index.html">QED</a> -->
    <a href="http://wiki.github.com/rubygengo/english">Wiki</a>
    <a href="http://github.com/rubygengo/english">Code</a>
  </div>

  <div id="table">
  <div id="notebook">
  <div id="page">

    <div style="position: absolute; right: 0; top: 0;">
      <a href="http://rubyworks.github.com/facets"><img src="assets/images/itcamefrom.png"/></a>
    </div>

    <span id="name">English<!-- Ink --></span> <br/>
    <span id="brief">Text and Language Processing</span>

    <br/><br/>

    <h2>Welcome</h2>

    <div class="section">
      <p>English is a collection English-related text manipulation and natural language
      processing libraries for the Ruby programming language. Over time the project hopes
      to provide a fairly comprehensive set of tools for working with English language data.</p>

      <p>Probably the most typical example of it use is:</p>

      <pre>
        require 'english/inflect'

        "boy".en.plural      #=> "boys"
        "boys".en.singular   #=> "boy"

        "ox".en.plural       #=> "oxen"
        "oxen".en.singular   #=> "ox"
      </pre>

      <p>By default the <code>$language</code> global variable is set to <code>'en'</code>.
      If the <code>english/mixin</code> library is loadeds the <code>#en</code> method call
      can be left out and the same result achieved.</p>

      <pre>
        require 'english/mixin'

        "boy".plural      #=> "boys"
        "boys".singular   #=> "boy"

        "ox".plural       #=> "oxen"
        "oxen".singular   #=> "ox"
      </pre>

      <p>English includes many other useful methods and also a few useful classes.
      <p>Each  library can be utilized independently. Or all libraries can be loaded with
      the single <code>require</code>.</p>

      <pre>
        require 'english'
      </pre>

      <p>For more details see the <a href="http://wiki.github.com/rubyworks/english">Wiki</a>
        or the <a href="rdoc/index.html">RDoc API documentation</a>.</p>
    </div>

    <h2>Resources</h2>

    <br/>

    <div class="resource">
      <a href="grammar/gramdex.html">English Grammar</a> <br/>
      Explanations and Exercises written by Mary Ansell.
    </div>

<!--
    <div class="resource">
      <a href="http://mathworld.wolfram.com/">MathWorld</a> <br/>
      A free resource from Wolfram Research built on Mathematica
      technology.
    </div>
-->

    <br/><br/>

  </div>
  </div>
  </div>

  <div id="copyright">
    English, Copyright &copy; 2009 Thomas Sawyer<br/>
    Some included material has respective copyrights. See documentation for specifics.
  </div>

</div>

</body>
</html>
